Favicon

You are here: Home > API Reference > App Distribution > Store Published Applications > Send email notifications about new builds or updates

Send email notifications about new builds or updates

Required Permission: mad.store.publishedApplication.notify

Sends customized email notifications to selected user groups including collaborators, employees, or specific user audiences informing them about new build availability or updates in the published application with support for custom email subject, message text, language selection, and audience filtering enabling targeted communication for application deployment announcements and update notifications.

POST
https://api.applivery.io/v1/organizations/{organizationId}/stores/{storeId}/pubApps/{publishedApplicationId}/notify 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/stores/{storeId}/pubApps/{publishedApplicationId}/notify" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "configuration": {
    "notifyCollaborators": true,
    "notifyEmployees": true,
    "filter": []
  },
  "language": "en",
  "emailText": "string",
  "emailSubject": "string",
  "userAudienceIds": [
    "string"
  ]
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/stores/{storeId}/pubApps/{publishedApplicationId}/notify", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "configuration": {
      "notifyCollaborators": true,
      "notifyEmployees": true,
      "filter": []
    },
    "language": "en",
    "emailText": "string",
    "emailSubject": "string",
    "userAudienceIds": [
      "string"
    ]
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/stores/{storeId}/pubApps/{publishedApplicationId}/notify",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "configuration": {
        "notifyCollaborators": true,
        "notifyEmployees": true,
        "filter": []
      },
      "language": "en",
      "emailText": "string",
      "emailSubject": "string",
      "userAudienceIds": [
        "string"
      ]
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
storeId number
required
publishedApplicationId string
required
Unique published application identifier to locate the specific published application record for deletion from the store catalog and distribution system.
Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json
configuration object required
Notification targeting configuration defining recipient groups and filtering criteria for selective communication about build availability.
notifyCollaborators any optional
Boolean flag indicating whether application collaborators should receive notifications for this event, enabling selective communication based on user roles.
notifyEmployees any optional
Boolean flag indicating whether organization employees should receive notifications for this event, enabling broad internal communication.
filter array [array] required
Group-based filtering criteria using nested arrays where inner arrays represent OR conditions and outer array represents AND conditions for targeted notifications.
language any required
Language code for notification localization determining email template, subject line, and content language for internationalized communications.
emailText any optional
Custom email body content in plain text or HTML format for personalized notification messages beyond default templates.
emailSubject any optional
Custom email subject line for notification messages, replacing default subject with context-specific information.
userAudienceIds array [string] optional
Array of user audience identifiers for targeting specific pre-defined user segments with build notifications instead of general collaborator or employee groups.
{
    "configuration": {
        "notifyCollaborators": true,
        "notifyEmployees": true,
        "filter": [
            [
                "string"
            ]
        ]
    },
    "language": "en",
    "emailText": "string",
    "emailSubject": "string",
    "userAudienceIds": [
        "string"
    ]
}

Responses

200 Response application/json
status boolean required
data object required
done any required 
{
    "status": true,
    "data": {
        "done": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}